#region Copyright 
// Copyright 2017 Gigya Inc.  All rights reserved.
// 
// Licensed under the Apache License, Version 2.0 (the "License"); 
// you may not use this file except in compliance with the License.  
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
#endregion

using System.Collections.Generic;
using System.Threading.Tasks;

namespace Gigya.Microdot.Interfaces.Events
{

    // TODO: rename class, to reflect it now also contains serialized fields
    public class PublishingTasks
    {
        /// <summary>
        /// A task indicating whether the event was published (true), explicitly suppressed due to configuration (false),
        /// or an exception in case the queue got full. Beware of awaiting on that task; it may take a long time to
        /// complete (depending on the event publisher; it might retry sending the event until successful).
        /// </summary>
        public Task<bool> PublishEvent;
        public Task<bool> PublishAudit = null;

        /// <summary>
        /// A lazy collection representing the set of fields that were found in the event object and their serialized
        /// values, that are being published.
        /// </summary>
        public IEnumerable<SerializedEventField> SerializedEventFields;
        public IEnumerable<SerializedEventField> SerializedAuditEventFields = null;
    }
}